package cn.oms.billing.provider.swagger;

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
@Slf4j
public class Swagger2Config {

    // api接口包扫描路径
    public static final String SWAGGER_SCAN_BASE_PACKAGE = "cn.oms.billing.provider.controller";

    // 当前版本号
    public static final String VERSION = "1.0.0";

    @Bean
    public Docket createRestApi() {
        log.info("======================== oms-billing-service账单服务 开启Swagger2：" + true + " ========================");
        return new Docket(DocumentationType.SWAGGER_2)
                //apiInfo： 添加api详情信息，参数为ApiInfo类型的参数，这个参数包含了第二部分的所有信息比如标题、描述、版本之类的，开发中一般都会自定义这些信息
                .apiInfo(apiInfo())
                .select()
                //apis： 添加过滤条件,
                //加了ApiOperation注解的类，才生成接口文档
                .apis(RequestHandlerSelectors.basePackage(SWAGGER_SCAN_BASE_PACKAGE))
//                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any()) // 可以根据url路径设置那些请求加入文档，忽略那些请求
                .build();
    }

    //基本信息的配置，信息会在api文档上显示
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("账单服务api文档") // 设置文档的标题
                .description("Swagger2的邮件服务api文档,如有调用问题请发送邮箱：1053831730@qq.com") // 设置文档的描述
                .contact(new Contact("曾晨AllenChen","https://github.com/Allen-zc","1053831730@qq.com"))
                .termsOfServiceUrl("http://localhost:8080/billing") // 设置文档的Lucense信息->1.3 License information
                .version(VERSION) // 设置文档的版本信息->1.0.0 Version information
                .build();
    }

}
